home *** CD-ROM | disk | FTP | other *** search
/ Shareware Avalanche! / Shareware Avalanche!.iso / brainex / compile.doc < prev    next >
Text File  |  1992-12-23  |  8KB  |  238 lines
  1.                           RomBrain Quick Compilers
  2.  
  3.  
  4. Rombrain offers two programs to help you create your own CD-ROM
  5. file base using almost any CD-ROM.  Before you attempt to make
  6. a filebase, please check with The Brainex System, as you may be
  7. able to save a lot of time by downloading a ready made filebase
  8. for your CD-ROM!
  9.  
  10. ===========
  11. COMPILE.EXE   
  12. ===========
  13. Automatically creates filebases for: 
  14. CARRS (Night Owl), RBBS in a BOX, SO MUCH SHAREWARE, 
  15. SO MUCH STAREWARE, SHAREWARE GRAB BAG, and WALNUT CREEK.
  16.  
  17. You may also use a CD-ROM that has a PCBoard DIR.LST file
  18. by selecting Walnut Creek.
  19.  
  20.  
  21. ==========
  22. CUSTOM.EXE
  23. ==========
  24. Since there are so many CD-ROMs with different directory formats,
  25. Rombrain offers CUSTOM.EXE. 
  26.  
  27. Custom uses the following files to create a filebase:
  28.  
  29. FILES.TXT   -  A list of Category Name, Directory Locations, and File
  30.                Description Locations.
  31.  
  32. DIRS.TXT    -  A list of directories to be included in FILES.TXT. 
  33.                DIRS.TXT is read when using the automatic FILES.TXT 
  34.                create function.
  35.  
  36. NOFILES.TXT -  A list of filenames or extensions to be EXCLUDED 
  37.                from FILES.TXT. NOFILES.TXT is read when using the 
  38.                automatic FILES.TXT create function.
  39.                Example:
  40.                README.TXT
  41.                .ZOO
  42.                BBSAD
  43.                \BBS\README
  44.  
  45. In the above example, the following will not be included in the filebase:
  46. All README.TXT files in all directories
  47. All files with the extension of .ZOO in all directories
  48. All BBSAD with any extension in all directories
  49. All README with any extension ONLY in the BBS directory
  50.  
  51.  
  52.  
  53.  
  54.  
  55. The first step in making a filebase is the creation of FILES.TXT.
  56.  
  57. CREATION OF FILES.TXT
  58. ---------------------
  59.  
  60. STEP 1
  61. ------
  62. Determine the name and location of the description files for your
  63. CD-ROM directories. They are usually called 00_INDEX.TXT or FILES.BBS.
  64.  
  65. If your CD-ROM does not have description files, Custom will AUTOMATICALLY
  66. create a filebase using filenames, dates and sizes.
  67.  
  68. Description Files
  69. -----------------
  70. These files should use the following format:
  71.  
  72. Each file described should have a description line with 
  73. the following elements:
  74.  
  75. FILENAME  SIZE  DATE  DESCRIPTION
  76.  
  77. An optional extended description line should start at column 32, and
  78. should begin with the | character.
  79.                                                   
  80. Compiler can create a filebase with just a FILENAME.
  81. Date and Filesize are obtained from the actual file on the CD-ROM.
  82. If there is no descripition, Rombrain will simply leave the description
  83. area blank.
  84.  
  85.  
  86. Examples:
  87.  
  88. ALADDIN.ZIP     89867  08/25/92  Aladdin's Magic Lamp Text Adventure
  89.                                 |From The System Brainex
  90.  
  91. ALADDIN.ZIP  08-25-92  Aladdin's Magic Lamp Text Adventure
  92.  
  93. ALADDIN.ZIP  Aug-25-92  Aladdin's Magic Lamp Text Adventure
  94.  
  95. ALADDIN.ZIP  Aug-25-1992  Aladdin's Magic Lamp Text Adventure
  96.  
  97. ALADDIN.ZIP  89867 Aladdin's Magic Lamp Text Adventure
  98.  
  99. ALADDIN.ZIP  Aladdin's Magic Lamp Text Adventure
  100.  
  101. Compiler will work with just about any format description line!
  102.  
  103.  
  104. STEP 2
  105. ------
  106. Select Menu Choice 2 to enter the name of the description file.
  107.  
  108. STEP 3
  109. ------
  110. Select Menu option 3 to create FILES.TXT. Enter the path
  111. of FILES.TXT, usually the current directory.
  112.  
  113. You can MANUALLY or AUTOCREATE the FILES.TXT
  114.  
  115.  
  116. Hit A to automatically create a filebase for every file on the CD-ROM.
  117. If no Description file is set, Custom will create a filebase using
  118. filename, size and date. EVERY file on the CD-ROM will be indicated,
  119. so it's suggested that you EDIT DIRS.TXT after the FILES.TXT is created
  120. before you compile the filebase. Once DIRS.TXT is created, you can 
  121. autocreate FILES.TXT again, and it will only include directories included
  122. in DIRS.TXT.
  123.  
  124. Hit M to use the internal FILES.TXT creator.
  125.  
  126. If you answer M to manually create a files.txt, you can use the compiler's
  127. internal FILES.TXT creator. 
  128.  
  129. You can hit ENTER to add CD-ROM categories
  130. [L]ist shows categories entered so far.
  131. [D]elete removes categories entered.
  132.  
  133. When you enter categories, you will be asked for three items 
  134. for each CD-ROM file category:
  135.  
  136. 1. Category Description
  137. 2. Directory name
  138. 3. Directory\Name of Description Text File
  139.  
  140.  
  141. Let's assume our CD-ROM has 3 categories. They are located on the CD-ROM
  142. in directories: COMS, COMS\UTIL, and ART.  A text file with descriptions
  143. for each category is located on the CD-ROM in a TEXT directory. 
  144. The file names are COMS.LST, COMUTIL.LST, and ART.LST.  These are
  145. examples only, as each CD-ROM is different!
  146.  
  147. The FILES.TXT creator will ask for:
  148.  
  149.  
  150. CATEGORY
  151. --------
  152. Brief description of this category (28 characters Max.)
  153.  
  154. CD-ROM directory
  155. ----------------
  156. This is the directory that holds the files of the category.
  157. List only the directory name. Do NOT include the drive letter.
  158. Custom will verify the directory on the CD-ROM.
  159.  
  160. DRIVE\DIRECTORY\FILENAME of Description File
  161. --------------------------------------------
  162. Complete path and filename of file description text file.
  163.  
  164.  
  165. EDITING FILES.TXT
  166. =================
  167. You can use menu selection 4 to edit FILES.TXT.
  168.  
  169.  
  170. Format of FILES.TXT
  171. -------------------
  172. "DESCRIPTION","DIRECTORY","DRIVE\DIRECTORY\FILENAME"
  173. or
  174. "DESCRIPTION","DIRECTORY","DRIVE\DIRECTORY\"
  175.  
  176. Example FILES.TXT
  177. -----------------
  178. "Word Processing","WORD","E:\WORD\FILES.BBS"
  179. "Communications","ROM1","E:\TEXT\ROM1"
  180. "Modem Programs","ROM2","E:\TEXT\ROM2"
  181. "Text Files","ROM2\TEXT","E:\TEXT\ROM2\TEXT"
  182. "Misc. Files","ROM2\TEXT","E:\MISC\"
  183.    ^               ^        ^
  184.    |               |        |
  185.    |               |        Drive\Directory\Filename of description files
  186.    |               |
  187.    |               Path\Directory on the CD that contains the files
  188.    |
  189.    Description of Category
  190.  
  191. Enclose each item in quotes "  " and seperate the items with a comma.
  192.  
  193. Note that the last line does not have a description filename. Compiler
  194. will include the files in the MISC directory automatically. Since
  195. there is no description file, descriptions for this category
  196. will not be shown by Rombrain.
  197.  
  198. RomBrain supports up to 250 categories for each CD-ROM.
  199.  
  200.  
  201.  
  202. Errors during compile
  203. ---------------------
  204. Error 62
  205. End of file - You left out a comma or information field in FILES.TXT
  206. The compiler ran out of information to read.
  207.  
  208. Error 53,64,76,75
  209. These are file access errors. Bad filename or path.
  210. A description file can't be found on the CD.
  211.  
  212.  
  213. ADDING THE FILEBASE TO BRAINEX
  214. ------------------------------
  215. After you compile your filebase, use Brainset to add the new filbase 
  216. information into the Brainex Door Manager. Insert the CD into the drive, 
  217. then run Brainset. The filebase created will be type D so be sure 
  218. select that type of CD.
  219.  
  220. Problems:
  221. If the filebase is created without errors, but RomBrain reports that
  222. a selected file is OFF-LINE or NOT FOUND, then there is an internal
  223. error in the filebase structure. If you wish to have a custom filebase 
  224. created for your CD, please contact me at the Brainex System. I can
  225. usually create a filebase for you. You will need to ship the CD to
  226. me with a prepaid return mailer. I'll do my best to create a filebase for
  227. you, then return your CD by mail.  
  228.  
  229. *** Please make arrangements with me BEFORE you ship the CD-ROM! ***
  230. ***             Your CD-ROM may not be be returned!              ***
  231.  
  232. Stanley Sheff
  233. The Brainex System
  234. 310-275-2344
  235. 310-273-5234
  236.  
  237.  
  238.